Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README #7

Merged
merged 11 commits into from
Nov 17, 2015
Merged

README #7

merged 11 commits into from
Nov 17, 2015

Conversation

RamonGilabert
Copy link
Contributor

No description provided.

@RamonGilabert RamonGilabert changed the title [WIP] README README Nov 17, 2015
@@ -4,12 +4,44 @@
[![License](https://img.shields.io/cocoapods/l/Whisper.svg?style=flat)](http://cocoadocs.org/docsets/Whisper)
[![Platform](https://img.shields.io/cocoapods/p/Whisper.svg?style=flat)](http://cocoadocs.org/docsets/Whisper)

## Description

Break the silence of your UI whispering or shouting at it. **Whisper** is a component that will make the task of display messages and in-app notifications simple. It has two different views inside.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Break the silence of your UI whispering or shouting at it.
Shouldn't it be a comma in there somewhere? 😎

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh really? I don't see it!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well sorta.

@RamonGilabert
Copy link
Contributor Author

@zenangst done, although this will change once I have some logo and stuff.


![In-App](https://github.com/hyperoslo/Whisper/blob/feature/README/Resources/in-app-notification.png)

Fully customizable, from colors to fonts. This view will have an optional action that will be called if the user taps the view.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This view will have an optional action that will be called if the user taps the view.

I think it's a bit confusing to refer to it as a view in this context, maybe something like.

Shouts have an optional action that will be called if the user taps on the shout.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouts have an optional action that will be called if the user taps on it.


Fully customizable, from colors to fonts. This view will have an optional action that will be called if the user taps the view.

The factory will handle the inset of the scroll view and adjust it to fit the Whisper, if you move from one view controller to another, it will animate the next controller's offset too.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The factory will handle the inset of the scroll view and adjust it to fit the Whisper, if you move from one view controller to another, it will animate the next controller's offset too.

There is no need to think about scroll view insets anymore, this will be handled automagically by 
Whisper. As and added bonus, when transitioning from one view controller to another, 
the next controllers offset will be adjusted like you would except. It just works!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OUTDATED, outrageous!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now it's fine!

```

Shouts let you add more properties like duration or action. With this last one, you'll get notified when the user **taps** the view.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouts let you add more properties like duration or action. With this, you'll get notified when the user **taps** the view.

You mentioned action already so I think that could be dropped here.

Shouts also have a duration property that allows you to pinpoint exactly how long the shout should be displayed.

```

Shouts also have a duration property that allows you to pinpoint exactly how long the shout should be displayed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this could be move to line 21? Where we mention the other features?

@zenangst
Copy link
Contributor

@RamonGilabert any ideas for a logo? 😎

@RamonGilabert
Copy link
Contributor Author

I'll check it out today.

zenangst added a commit that referenced this pull request Nov 17, 2015
@zenangst zenangst merged commit 94febf2 into master Nov 17, 2015
@zenangst zenangst deleted the feature/README branch November 17, 2015 15:42
@zenangst
Copy link
Contributor

@RamonGilabert 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants